Login user

POST

https://api.applivery.io/v1/auth/login

curl -X POST "https://api.applivery.io/v1/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
  "provider": "traditional",
  "payload": {
    "email": "[email protected]",
    "password": "string",
    "twoFactorCode": "string"
  },
  "language": "es"
}'

const response = await fetch("https://api.applivery.io/v1/auth/login", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "provider": "traditional",
    "payload": {
      "email": "[email protected]",
      "password": "string",
      "twoFactorCode": "string"
    },
    "language": "es"
  }),
});

const data = await response.json();

import requests

response = requests.post(
    "https://api.applivery.io/v1/auth/login",
    json={
      "provider": "traditional",
      "payload": {
        "email": "[email protected]",
        "password": "string",
        "twoFactorCode": "string"
      },
      "language": "es"
    },
)

data = response.json()

Request

Body Params application/json

provider string required

traditional google github bitbucket

payload object required

email string required

≤ 256 characters · Format: email

password string required

≤ 128 characters

twoFactorCode string optional

≤ 6 characters

language string optional

es en fr de it zh pt ru

{
    "provider": "traditional",
    "payload": {
        "email": "[email protected]",
        "password": "string",
        "twoFactorCode": "string"
    },
    "language": "es"
}

Responses

200 Response application/json

status boolean optional

data object optional

accessToken object optional

token string optional

≤ 128 characters

expireAt string optional

Format: date-time

refreshToken object optional

token string optional

≤ 128 characters

expireAt string optional

Format: date-time

user object optional

id string optional

Unique identifier for the user account within the platform, used to reference this specific user across all authentication, authorization, and audit logging throughout the system.

Match pattern: ^[a-fA-F0-9]{24}$

email string optional

Primary email address associated with the user account, used for authentication, notifications, password recovery, and all official communication from the platform to the user.

≤ 256 characters · Format: email

firstName string optional

User's given name or first name as provided during registration or profile updates, displayed in dashboards, and used for personalization throughout the user interface and email communications.

≤ 128 characters

lastName string optional

User's family name or surname as provided during registration or profile updates, used for display purposes in team lists and collaboration interfaces.

≤ 128 characters

fullName string optional

Computed concatenation of first and last names for convenient display in user interfaces, notifications, and reports without requiring separate name field handling in frontend applications.

≤ 128 characters

picture string optional

URL or path to the user's profile picture or avatar image, displayed in navigation menus, team listings, and collaboration interfaces to provide visual identification across the platform.

role string optional

Global platform role assigned to this user determining their system-wide permissions and access level, such as platform administrator, organization owner, or standard user with varying capabilities.

user serviceAccount platformUser platformServiceAccount

platformRoles array [object] optional

newsletter boolean optional

Flag indicating whether the user has opted in to receive newsletter emails, product updates, feature announcements, and marketing communications from the platform according to their communication preferences.

hasPassword boolean optional

Indicates whether the user has set a password for traditional email and password authentication, as opposed to relying solely on single sign-on or social authentication providers.

has2FAActive boolean optional

Flag indicating whether two-factor authentication is currently enabled for this user account, providing an additional security layer beyond password authentication to protect against unauthorized access.

ssoUser boolean optional

Indicates whether this user account was created through single sign-on integration with external identity providers like SAML, OAuth, or enterprise directory services rather than traditional registration.

organizationId string optional

Currently selected organization identifier for user, determining which workspace resources and applications are accessible.

Match pattern: ^[a-fA-F0-9]{24}$

organizations array [object] optional

Array of all organizations that this user is a member of with any role, enabling organization switching in the dashboard and determining the complete scope of accessible resources.

organizationInfo object optional

Detailed information about the currently active organization providing full context for the user session including branding, store configuration, and administrative settings.

language string optional

Preferred interface language code for the user determining the language used for dashboard labels, buttons, notifications, and all user-facing content supporting internationalization across the platform.

es en fr de it zh pt ru

verificationStatus string optional

Current email verification status of the user account indicating whether the user has confirmed ownership of their email address through the verification link sent during registration.

verified unverified unknown

activityTrace object optional

Activity tracking information capturing recent user actions, session history, and interaction timestamps for security monitoring and behavioral analytics.

intercomUserHash string optional

Secure hash used for identity verification when launching Intercom chat widget, ensuring that support conversations are authenticated and associated with the correct user account for privacy and security.

≤ 128 characters

createdAt string optional

ISO 8601 timestamp of user account creation recording when account registered for tracking account age and tenure analysis.

Format: date-time

updatedAt string optional

ISO 8601 timestamp of most recent modification indicating last update to user profile, password, preferences, or role assignments.

Format: date-time

supplantCapability string optional

none read write

{
    "status": true,
    "data": {
        "accessToken": {
            "token": "string",
            "expireAt": "2024-01-01T00: 00:00Z"
        },
        "refreshToken": {
            "token": "string",
            "expireAt": "2024-01-01T00: 00:00Z"
        },
        "user": {
            "id": "507f1f77bcf86cd799439023",
            "email": "[email protected]",
            "firstName": "John",
            "lastName": "Doe",
            "fullName": "John Doe",
            "picture": "https://example.com/images/profile-picture.jpg",
            "role": "user",
            "platformRoles": [
                {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "platformActions": [
                        "string"
                    ],
                    "supplant": {
                        "capability": "none"
                    },
                    "createdAt": "2024-01-01T00: 00:00Z",
                    "updatedAt": "2024-01-01T00: 00:00Z"
                }
            ],
            "newsletter": true,
            "hasPassword": true,
            "has2FAActive": false,
            "ssoUser": false,
            "organizationId": "507f1f77bcf86cd799439024",
            "organizations": [
                {
                    "id": "507f1f77bcf86cd799439025",
                    "name": "Enterprise Corporation",
                    "slug": "enterprise-corp",
                    "picture": "https://cdn.applivery.com/orgs/507f1f77bcf86cd799439025/logo.png"
                }
            ],
            "organizationInfo": {
                "id": "507f1f77bcf86cd799439026",
                "name": "Acme Industries",
                "slug": "acme-industries",
                "picture": "https://cdn.applivery.com/orgs/507f1f77bcf86cd799439026/logo.png",
                "createdBy": "507f1f77bcf86cd799439027",
                "branding": {
                    "primaryColor": "#0066CC",
                    "logoUrl": "https://cdn.example.com/logo.png"
                },
                "store": {
                    "enabled": true,
                    "customDomain": "apps.acme.com"
                },
                "configuration": {
                    "defaultStorageProvider": "507f1f77bcf86cd799439028",
                    "enforceSSO": true
                }
            },
            "language": "en",
            "verificationStatus": "verified",
            "activityTrace": {
                "lastLogin": {
                    "dashboard": "2024-01-01T00: 00:00Z",
                    "sdk": "2024-01-01T00: 00:00Z",
                    "store": "2024-01-01T00: 00:00Z"
                },
                "lastAction": {
                    "dashboard": "2024-01-01T00: 00:00Z",
                    "sdk": "2024-01-01T00: 00:00Z",
                    "store": "2024-01-01T00: 00:00Z"
                }
            },
            "intercomUserHash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
            "createdAt": "2025-06-15T10: 00:00Z",
            "updatedAt": "2026-02-03T15: 30:00Z",
            "supplantCapability": "none"
        }
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4014

message string optional

Required two factor code

{
    "status": false,
    "error": {
        "code": 4014,
        "message": "Required two factor code"
    }
}

403 Response application/json

status boolean optional

false

error object optional

code number optional

4006

message string optional

Invalid Credentials

{
    "status": false,
    "error": {
        "code": 4006,
        "message": "Invalid Credentials"
    }
}